Skip to main content

@pexip/plugin-api

plugin-api is a Typescript package for creating Pexip ("Web App 3") plugins.

To find out the most suitable package version for a particular Web App 3 deployment, one can go to the About Pexip section of the app and check Plugin API Version.

Install​

npm install @pexip/plugin-api

Usage​

import {registerPlugin} from '@pexip/plugin-api';

const plugin = await registerPlugin({id: 'your-plugin-name', version: 1});

void plugin.ui.showToast({message: 'Hello from the plugin'});

Documentation​

https://developer.pexip.com/docs/category/pexip-connect-for-web-webapp3-plugins